集群
# 列出集群信息
请求
GET /openapi/system/cluster
1
成功返回说明
| 类型 | 说明 |
|---|---|
| []OpenAPICluster | 集群信息列表 |
OpenAPICluster 参数说明
| 参数名 | 说明 | 类型 |
|---|---|---|
cluster_id | 集群 ID | string |
name | 集群名称 | string |
description | 描述 | string |
provider | 供应商：0：标准 Kubernetes 集群1：阿里云 ACK2：腾讯云 TKE3：华为云 CCE4：Amazon EKS5：腾讯云 TKE Serverless6：谷歌云 GKE7：微软云 AKS | int |
provider_name | 供应商名称 | string |
production | 是否为生产集群 | bool |
created_by | 创建者 | string |
created_time | 创建时间 | int |
local | 是否为本地集群 | bool |
status | 集群状态：normal：正常disconnected：断开连接pending：挂起abnormal：连接异常 | string |
type | 集群类型：agent：代理模式kubeconfig：直连模式 | string |
成功返回示例
[
{
"cluster_id": "0123456789****ef12345678",
"name": "local-20220823144517",
"production": true,
"description": "",
"provider": 0,
"provider_name": "标准 Kubernetes 集群",
"created_by": "system",
"created_time": 1661237117,
"local": true,
"status": "normal",
"type": "agent"
},
{
"cluster_id": "64b80b03f****553e5707fef",
"name": "tt",
"production": false,
"description": "",
"provider": 4,
"provider_name": "Amazon EKS",
"created_by": "admin",
"created_time": 1689783043,
"local": false,
"status": "pending",
"type": "agent"
}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# 创建集群
请求
POST /openapi/system/cluster
1
body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
name | 集群名称 | string | 是 |
type | 集群类型：agent：代理模式kubeconfig：直连模式 | string | 是 |
kube_config | Kubeconfig 配置，type为agent时可为空 | string | 是 |
production | 是否为生产集群 | bool | 是 |
provider | 供应商：0：标准 Kubernetes 集群1：阿里云 ACK2：腾讯云 TKE3：华为云 CCE4：Amazon EKS5：腾讯云 TKE Serverless6：谷歌云 GKE7：微软云 AKS | int | 是 |
description | 集群描述 | string | 是 |
project_names | 可以使用该集群的项目范围，如需设置所有项目，可使用<all_projects> | []string | 是 |
成功返回说明
| 参数名 | 类型 | 说明 |
|---|---|---|
cluster | OpenAPICluster | 集群信息 |
agent_cmd | string | agent接入命令，仅当type为agent时有效 |
成功返回示例
{
"cluster": {
"cluster_id": "0123456789****ef12345678",
"name": "local-20220823144517",
"production": true,
"description": "",
"provider": 0,
"provider_name": "标准 Kubernetes 集群",
"created_by": "system",
"created_time": 1661237117,
"local": true,
"status": "normal",
"type": "agent"
},
"agent_cmd": "kubectl apply -f \"http://course.8slan.com/api/aslan/cluster/agent/6657ee912d51d34e253e503f/agent.yaml?type=deploy\""
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 更新指定集群
请求
PUT /openapi/system/cluster/:id
1
路径参数说明
| 参数名 | 类型 | 描述 | 是否必须 | 默认值 |
|---|---|---|---|---|
id | string | 集群主键 | 是 | 无 |
body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
name | 集群名称 | string | 是 |
description | 集群描述 | string | 是 |
project_names | 可以使用该集群的项目范围，如需设置所有项目，可使用<all_projects> | []string | 是 |
body 参数示例
{
"name": "local-20220823144517-new",
"description": "本地集群",
"project_names": [
"<all_projects>",
]
}
1
2
3
4
5
6
7
2
3
4
5
6
7
成功返回说明
{message: "success"}
1
# 删除指定集群
请求
DELETE /openapi/system/cluster/:id
1
路径参数说明
| 参数名 | 类型 | 描述 | 是否必须 | 默认值 |
|---|---|---|---|---|
id | string | 集群主键 | 是 | 无 |
成功返回说明
{message: "success"}
1
# 检查集群 Istio 安装
请求
GET /openapi/cluster/istio/check/:id
1
路径参数说明
| 参数名 | 类型 | 描述 | 是否必须 | 默认值 |
|---|---|---|---|---|
id | string | 集群主键 | 是 | 无 |
成功返回说明
true
1
